.NET Framework Class Library |
TaskFactory<(Of <(TResult>)>)..::.StartNew Method (Func<(Of <(TResult>)>), CancellationToken) |
TaskFactory<(Of <(TResult>)>) Class See Also Send Feedback |
Creates and starts a Task<(Of <(TResult>)>).
Namespace:
System.Threading.Tasks
Assembly:
System.Threading (in System.Threading.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function StartNew ( _ function As Func(Of TResult), _ cancellationToken As CancellationToken _ ) As Task(Of TResult) |
C# |
---|
public Task<TResult> StartNew( Func<TResult> function, CancellationToken cancellationToken ) |
Parameters
- function
- Type: System..::.Func<(Of <(TResult>)>)
A function delegate that returns the future result to be available through the Task<(Of <(TResult>)>).
- cancellationToken
- Type: System.Threading..::.CancellationToken
The CancellationToken that will be assigned to the new task.
Return Value
The started Task<(Of <(TResult>)>).Remarks
Calling StartNew is functionally equivalent to creating a Task<(Of <(TResult>)>) using one
of its constructors and then calling
Start to schedule it for execution.
However, unless creation and scheduling must be separated, StartNew is the recommended approach
for both simplicity and performance.
Exceptions
Exception | Condition |
---|---|
System..::.ArgumentNullException | The exception that is thrown when the function argument is null. |
System..::.ObjectDisposedException | The provided CancellationToken has already been disposed. |